Command Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Indicates commands new in PageStream4.0.
Indicates commands with new functionality in PageStream4.0.

Command Table of Contents

Color
Dialog Box
Document
Drawing
File
Object
Style
System
Text
* Amiga Only

Color

Commands

Filled
SetColor
SetColorCount
SetColorStyle
SetColorTint
SetFill
SetFPattern
SetFPatternStyle
SetScreen
SetSrokeWeight
SetStroke
SetStrokeBegin
SetStrokeCap
SetStrokeCount
SetStrokeEnd
SetStrokeJoin
SetStrokeOffset
SetStrokeStyle
SetTrapping
Stroked

Dialog Box

Commands

AddArexxGadget
AddArexxList
AllocArexxList
AllocArexxRequester
CloseBusyRequester
DoArexxRequester
FreeArexxList
FreeArexxRequester
GetArexxGadget
OpenBusyRequester
SetArexxGadget
SetBusyRequester

Queries

GetBusyRequester
GetCoord
GetRegion

Document

Commands

AddGuides
DeleteChapter
DeleteGuides
DeleteMasterPage
DeletePage
DisplayGrid
DisplayGuides
DisplayRuler
MakePageSpread
MoveChapter
MoveMasterPage
MovePage
NewChapter
NewDocument
NewMasterPage
SelectMasterPage
SetChapterDesc
SetChapterName
SetChapterNumbering
SetColumnGuides
SetDimensions
SetDocumentDesc
SetDocumentName
SetDocumentStatus
SetGrid
SetGuide
SetGuides
SetMarginGuides
SetMasterPageDesc
SetMasterPageName
SetPageDesc
SetPageName
SetPageNumbering
SetWindowPos
SnapToGrid
SnapToGuides

Queries

CurrentChapter
CurrentChapterPath
CurrentDocument
CurrentMasterPage
CurrentMasterPagePath
CurrentPage
CurrentPagePath
CurrentWindow
CurrentWindowPath
GetChapterDesc
GetChapterNumber
GetChapterNumbering
GetChapters
GetColumnGuides
GetDimensions
GetDocumentDesc
GetDocuments
GetDocumentStatus
GetDrawingDisplay
GetFacingPageDisplay
GetGreeking
GetGrid
GetGridDisplay
GetGridSnap
GetGuide
GetGuideDisplay
GetGuides
GetGuideSnap
GetInvisibleDisplay
GetMarginGuides
GetMasterPageDesc
GetMasterPages
GetOutlineDisplay
GetPageDesc
GetPageMasterPage
GetPageName
GetPageNumbering
GetPictureDisplay
GetRulerDisplay
GetTextLinkDisplay
Greeking

Drawing

Commands

AddDrawingMaskPoint
AddEPSMaskPoint
AddPictureMaskPoint
AddPoint
AddTextFXPoint
ClosePath
CreateColumns
CreateCompound
CreateDrawing
CreatePath
CreatePoint
DeletePoint
DrawBox
DrawColumn
DrawEllipse
DrawEPS
DrawGrid
DrawLine
DrawPicture
DrawPolygon
DrawTextObj
MovePoint
NudgePoint
SelectPoint
SplitPoint

File

Commands

CloseDocument
CloseWindow
CollectOutput
ExportGraphic
ExportPDF
ExportText
InsertText
LogRevision
Open
OpenDocument
OpenWindow
PlaceGraphic
PrintDocument
RevertDocument
SaveDocument
SetArticle
SetJobNumbering
SetRevisonTracking

Object

Commands

AddToDrawing
Align
BringForward
BringToFront
ClearMask
ConvertToPath
CopyObject
CutObject
DeleteObject
DissolveCompund
DissolveDrawing
DissolveEPS
DissolveObject
Distribute
Duplicate
EditBox
EditColumn
EditCompound
EditDrawing
EditEllipse
EditEPS
EditGroup
EditLine
EditObject
EditPath
EditPicture
EditPoint
EditPolygon
EditTextObj
Filled
GenerateMask
Lock
MakeMask
MakeTextFxPath
MergePaths
Move
MoveToPage
Nudge
PasteObject
ReleaseMask
Rotate
ScaleObject
SelectActiveLayer
SelectObject
SendBackward
SendToBack
SetDoubleClick
SetEPS
SetObjectLock
SetTextFrame
SetTextWrap
SimplifyPath
Skew
SmoothPath
SplitPaths
Transform
Ungroup
Unlock

Queries

GetBox
GetColumn
GetCompound
GetDrawing
GetEllipse
GetEPS
GetGridObject
GetGroup
GetLine
GetObject
GetObjectLock
GetPath
GetPicture
GetPolygon
GetRotation
GetSelectedObjects
GetTextFrame
GetTextObj
GetTextWrap
Group

Style

Commands

AppendStyleTags
BeginStyleTag
DeleteStyleTag
EndStyleTag
NewStyleTag
SaveStyleTags
SetCharacterStyle
SetObjectStyle
SetParagraphStyle
SetStyleName
SetStyleTag

System

Commands

BeginCommandCapture
BeginPrefCapture
ColorPalette
Display
DocumentPalette
EndCommandCapture
EndPrefCapture
HideWindow
LayerPalette
LoadPrintPrefs
LoadSettings
LoadSnapShot
LockInterface
MainToolBox
PagePalette
Quit
RecentFiles
Redo
Refresh
RefreshWindow
RevealWindow
SavePrintPrefs
SaveSettings
SaveSnapShot
ScriptPalette
SelectOnPaste
SetArcDefaults
SetAutoColumns
SetBackup
SetBoxDefaults
SetColumnDefaults
SetDocumentPath
SetDuplicateDefaults
SetGraphicPath
SetGridDefaults
SetMagnifyIncrement
SetMeasurements
SetMoveDefaults
SetNudgeDefaults
SetPolygonDefaults
SetSmart
SetTextPath
SetToolbar
SetToolMode
SetUndoLevels
SetViewDefaults
SetWindowDefaults
SetWindowName
StylePalette
ToolBar
Undo

Queries

GetDisplay
GetRedo
GetRefreshMode
GetUndo
GetWindowPos
GetWindows

Text

Commands

ApplyAttributes
BreakTextRouting
CopyText
CutText
DeleteBookmark
DeleteFigureType
DeleteIndexTopic
DeleteIndexXRef
DeleteIndexMark
DeleteText
DeleteVariable
DropText
EditBookmark
EditFigureType
EditIndexTopic
EditText
FindText
GenerateIndex
GenerateTOC
GenerateTOF
Insert
InsertBookmark
InsertBreak
InsertChar
InsertControl
InsertDash
InsertDate
InsertFigure
InsertIndexMark
InsertName
InsertNumber
InsertPage
InsertRevision
InsertSoft
InsertSpace
InsertTime
NewFigureType
NewIndexTopic
NewIndexXRef
PasteText
PickupAttributes
RemovePairKern
RemoveSoft
ReplaceAttr
ReplaceText
SelectText
SetAlignment
SetArticleDesc
SetArticleName
SetBaseline
SetBaselineLeading
SetBold
SetBullet
SetCase
SetDefaultTabstop
SetDrawing
SetDropCap
SetFirstLine
SetFont
SetHyphenation
SetHyphenLanguage
SetIndent
SetIndex
SetItalic
SetJustification
SetKerning
SetLanguage
SetLastLineFlush
SetLeading
SetLigature
SetMinLineLength
SetNormal
SetNumbered
SetOutline
SetPairKern
SetParagraphLeading
SetPicture
SetReverse
SetRuleAbove
SetRuleBelow
SetScript
SetShadow
SetSmallCaps
SetSubscript
SetSuperscript
SetTabRuler
SetTextRouting
SetTOC
SetTOF
SetTracking
SetTrackrange
SetTrackTable
SetTypeAngle
SetTypeSize
SetTypeWidth
SetUnderline
SetVariableName
SetVaribleValue
TextCursor

Queries

GetArticle
GetArticleDesc
GetArticleIDs
GetArticleName
GetArticleOverset
GetArticleWordCount
GetCursor
GetCursorCount
GetFontList

* Amiga Only

System Preferences

AppendFontPrefs
LoadFontPrefs
SaveFontPrefs
SetBitMapEditor
SetDrawingEditor
SetScriptPath
SetTextEditor

System Commands

*RX
ScreenToBack
ScreenToFront

Dialog

GetChoice
GetFile
GetFilePath
GetFontStyles

Functions

MSYS
P2D

Querys

GetErrorNumber
GetErrorString
GetPortName
GetScreenDPI
GetScreenName
GetString

Command & Query Format

<mandatory> Angles enclose mandatory parameters.

[optional] Brackets enclose optional parameters.

(group) Parentheses group together parameters.

(group)... An ellipsis after a group indicates that you can repeat the group of parameters one or more times.

a | b Vertical bars separate alternative parameters from which you must choose a single parameter.

Commands are case insensitive.

Arguments and Variables:

Some commands require you to enter an argument to the command or to specify a variable to hold a result. Variables and arguments in the command descriptions are followed by a backslash and a letter to indicate their type:

/i Integer: Whole numbers, positive or negative.
i.e., -2, -1, 0, 1, 2, 3\

/d Decimal: Any number.
i.e., 1.25, -13.789

/s String: Text. You can break text into lines by typing \\n. i.e., "My text", "More than one\\nline."

/v Variable: Used to hold a single result.

/a Array: A stem variable used to hold multiple results.

Object & Article ID Numbers

Many PageStream commands use the objectid and articleid parameters to specify which object or article is to be manipulated. ID numbers are assigned when an object or article is created. They are session-specific numbers are are not stored with the document.

Your scripts should store ID numbers when objects or articles are created or selected so that the script may modify them later. The ID numbers are not of use for anything other than scripts. Your script should get an ID number and use it as a handle for the object or article.

Dialog Box Commands

These commands are used to open dialog boxes from PageStream scripts. They require that PageStream be loaded.

Macintosh users should purchase FaceSpan from Software Designs Unlimited instead of using these commands, because FaceSpan provides much better dialog features. Contact Software Designs Unlimited at 214-578-6700 or FaceSpan@sdu.com.

New PageStream4.0 Command Parameters

These still need to be integrated into the command documentation.

ADDPOINT, CLOSEPATH, SELECTPOINT, CREATEPOINT, EDITPOINT, DELETEPOINT,
MOVEPOINT, NUDGEPOINT, SPLITPOINT work on TextObject TextFX Paths,
Drawing Masks, EPS Masks, and Picture Masks now.

...RULEABOVE | RULEBELOW] added to fill routines to set paragraph rules above
and below attributes using:
FILLED, STROKED, SETSTROKESTYLE, SETFPATTERNSTYLE, SETCOLORSTYLE,
SETSTROKECOUNT, SETSTROKE, SETSTROKEWEIGHT, SETSTROKEJOIN, SETSTROKEBEGIN,
SETSTROKEEND, SETSTROKECAP, SETSTROKEOFFSET, SETFILL, SETFPATTERN,
SETCOLORCOUNT, SETCOLOR, SETCOLORTINT, SETSCREEN

... OBJECTID objectid] and added to object drawing and selecting
commands for layers.